more lexicon fixes and polish by aspiers · Pull Request #28 · hypercerts-org/hypercerts-lexicon

aspiers · 2025-12-05T12:36:51Z

rename / remove "hypercert" fields
singular vs. plural
ERD layout improvements

Summary by CodeRabbit

Refactor
- Restructured core data types to use consistent singular naming conventions.
- Migrated system references from hypercerts to activities, with updated descriptions clarifying these relationships.
- Standardized contributor field naming and structure across the data model.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

This matches the rename of the main hypercert record to org.hypercerts.claim.activity.

We default to singular unless there is a reason to use plural.

coderabbitai · 2025-12-05T12:37:00Z

Walkthrough

Schema refactoring across Entity Relationship Diagram and lexicon definitions to rename plural dataclasses to singular forms (measurements → measurement, evaluations → evaluation, contributions → contribution) and update field references from "hypercert" to "activity" for evidence and measurement records.

Changes

Cohort / File(s)	Summary
Schema and Diagram Updates `ERD.puml`	Renamed dataclasses: measurements → measurement, evaluations → evaluation, contributions → contribution. Updated field references: hypercert → activity in multiple dataclasses. Renamed contributor[] to contributors[] in contribution dataclass. Adjusted diagram relationships to align with new names.
Lexicon: Evidence `lexicons/org/hypercerts/claim/evidence.json`	Renamed property from hypercert to activity. Updated description to reference the activity this evidence is for, specifying org.hypercerts.claim.activity conformance.
Lexicon: Measurement `lexicons/org/hypercerts/claim/measurement.json`	Renamed field from hypercert to activity in required fields and properties. Updated description to reference activity instead of hypercert.
Documentation `README.md`	Updated Hypercerts Evidence and Measurement lexicon documentation to reflect property name changes from hypercert to activity and adjusted descriptions accordingly.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Areas requiring extra attention:
- Verify all cross-references between activity, evidence, measurement, and contribution records are consistent across both JSON lexicons and diagram
- Confirm that the activity reference structure matches the org.hypercerts.claim.activity lexicon specification
- Check that downstream code/implementations referencing the old hypercert field have been or will be updated

Possibly related PRs

Lexicon review #23 — Related schema refactoring that removes hypercert references and updates cross-entity relationships between activity, evidence, measurement, and contribution lexicons.

Poem

🐰 Hop along to the future bright,
where activity shines with newfound light!
Singular names in a measured way,
the schema dances, hip-hip-hooray! 🎉
Contributions and claims, now they align,
measurements and evidence perfectly fine!

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'more lexicon fixes and polish' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific changes.	Consider a more specific title like 'Refactor hypercert field to activity and standardize dataclass naming' to clearly communicate the main changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

lexicons/org/hypercerts/claim/evidence.json (1)
43-47: Minor inconsistency in description.

The createdAt description still references "hypercert claim" while the rest of the schema has been updated to use "activity" terminology.
          "createdAt": {
            "type": "string",
            "format": "datetime",
-            "description": "Client-declared timestamp when this hypercert claim was originally created"
+            "description": "Client-declared timestamp when this evidence record was originally created"
          }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c1d85a9 and 92b40c6.

⛔ Files ignored due to path filters (4)

ERD-with-fields.png is excluded by !**/*.png
ERD-with-fields.svg is excluded by !**/*.svg
ERD.png is excluded by !**/*.png
ERD.svg is excluded by !**/*.svg

📒 Files selected for processing (4)

ERD.puml (4 hunks)
README.md (2 hunks)
lexicons/org/hypercerts/claim/evidence.json (1 hunks)
lexicons/org/hypercerts/claim/measurement.json (1 hunks)

🔇 Additional comments (8)

lexicons/org/hypercerts/claim/evidence.json (1)

13-16: LGTM! The rename from hypercert to activity is correctly implemented with an appropriate description referencing org.hypercerts.claim.activity.

lexicons/org/hypercerts/claim/measurement.json (1)

11-16: LGTM! The rename from hypercert to activity is properly implemented:

Added to required fields

Property renamed with updated description

Correctly references org.hypercerts.claim.activity lexicon

README.md (2)

177-179: LGTM! Documentation correctly updated to reflect the activity field rename, with proper required status (optional) matching the evidence lexicon schema.

198-200: LGTM! Documentation correctly updated to reflect the activity field rename, with proper required status (required) matching the measurement lexicon schema.

ERD.puml (4)

73-75: LGTM! The dataclass correctly renamed from measurements to measurement (singular), with the activity field properly replacing hypercert.

87-97: LGTM on singular rename. The dataclass correctly renamed from evaluations to evaluation.

Note that measurements[]? (line 94) references the now-singular measurement class, which is correctly handled by the relationship on line 155.

99-108: LGTM! The dataclass correctly renamed from contributions to contribution, and the field contributor[] is properly renamed to contributors[] for clarity.

148-161: LGTM! Edge relationships correctly updated to reference the renamed singular dataclass names (contribution, measurement, evaluation).

aspiers added 5 commits December 5, 2025 13:02

rename "hypercert" fields to "activity"

b089a1b

This matches the rename of the main hypercert record to org.hypercerts.claim.activity.

remove "hypercert" from contribution

fe039de

fix contribution

d613e3d

Make singular / plural usage consistent.

49a9b02

We default to singular unless there is a reason to use plural.

improve ERD layout

92b40c6

aspiers requested review from holkexyz and s-adamantine December 5, 2025 12:37

coderabbitai Bot reviewed Dec 5, 2025

View reviewed changes

aspiers requested a review from bitbeckers December 5, 2025 17:32

holkexyz approved these changes Dec 5, 2025

View reviewed changes

aspiers merged commit f0536b5 into hypercerts-org:main Dec 5, 2025
2 checks passed

aspiers deleted the hypercert-field branch December 5, 2025 17:52

This was referenced Dec 5, 2025

make measurement::activity optional #29

Merged

adding project schema (and keeping collections consistent) #33

Merged

adding scale to eval, consistency reg subject of these schemas, tid everywhere #34

Merged

This was referenced Dec 15, 2025

clarify different diagram class types #39

Merged

Link from evaluation to measurements #8

Merged

coderabbitai Bot mentioned this pull request Mar 2, 2026

docs: clarify expected lexicon types in contributorIdentity and contributionDetails descriptions #157

Merged

Navigation Menu

Uh oh!

more lexicon fixes and polish - #28

more lexicon fixes and polish#28
aspiers merged 5 commits into
hypercerts-org:mainfrom
aspiers:hypercert-field

aspiers commented Dec 5, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Dec 5, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

aspiers commented Dec 5, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

aspiers commented Dec 5, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Dec 5, 2025 •

edited

Loading